Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Relgen: Second gen relnotes generator first commit. #6184

Merged
merged 11 commits into from
Nov 18, 2024

Conversation

djw-m
Copy link
Contributor

@djw-m djw-m commented Oct 25, 2024

What Changed?

Builds on relnoted but is independent of it.

relgen.js -p relnotedir

Reads config from src/meta.yml
Then processes all the release notes files in the directory
Creates index.mdx and releasenote files.

@djw-m djw-m requested a review from a team as a code owner October 25, 2024 14:48
@jpe442 jpe442 added the deploy Add this label to a PR and it will automatically be deployed to netlify label Oct 25, 2024
Copy link
Contributor

github-actions bot commented Oct 25, 2024

@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 25, 2024 15:03 Inactive
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 28, 2024 11:05 Inactive
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 28, 2024 12:41 Inactive
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 28, 2024 14:07 Inactive
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 28, 2024 15:37 Inactive
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 29, 2024 10:09 Inactive
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 29, 2024 14:23 Inactive
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 30, 2024 05:50 Inactive
@josh-heyer josh-heyer force-pushed the docs/tools/relnote-generator-two branch from 091781f to 66eaff6 Compare October 30, 2024 18:16
@josh-heyer
Copy link
Contributor

⚠Rebased to fix link errors

@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 30, 2024 18:21 Inactive
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two October 30, 2024 18:37 Inactive
djw-m and others added 10 commits November 14, 2024 17:02
Signed-off-by: Dj Walker-Morgan <[email protected]>
Signed-off-by: Dj Walker-Morgan <[email protected]>
Signed-off-by: Dj Walker-Morgan <[email protected]>
Signed-off-by: Dj Walker-Morgan <[email protected]>
Also clean up display of code blocks a bit,
and implement some sensible page breaks
Also some sensible layout and page break controls for printing
Also fix omitted import in relgen.js
@djw-m djw-m force-pushed the docs/tools/relnote-generator-two branch from 6ae9a93 to f9224ca Compare November 14, 2024 17:02
@github-actions github-actions bot temporarily deployed to pr-6184-docs-tools-relnote-generator-two November 14, 2024 17:14 Inactive
Copy link
Contributor

@josh-heyer josh-heyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems pretty solid; it's a clear improvement over what we have now, and it would be good to put this to use during releases as soon as possible.

Todo in the future:

  • more robust handling of input strings (currently possible to break table rendering with poor choice of date or version names)
  • Pretty-printing for both Markdown and HTML tables

@djw-m
Copy link
Contributor Author

djw-m commented Nov 18, 2024

Noted on the changes. Feeling pretty, might make tickets later.

@djw-m djw-m merged commit 4713c57 into develop Nov 18, 2024
3 checks passed
@djw-m djw-m deleted the docs/tools/relnote-generator-two branch November 18, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Add this label to a PR and it will automatically be deployed to netlify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants